Skip to content

docs: add hackathons list API documentation#5313

Merged
Anushreebasics merged 3 commits into
SandeepVashishtha:masterfrom
git-Rag:docs/hackathons-list-api
Jun 2, 2026
Merged

docs: add hackathons list API documentation#5313
Anushreebasics merged 3 commits into
SandeepVashishtha:masterfrom
git-Rag:docs/hackathons-list-api

Conversation

@git-Rag

@git-Rag git-Rag commented Jun 1, 2026

Copy link
Copy Markdown
Contributor

Related Backend Implementation

SandeepVashishtha/Eventra-Backend#48

Description

This PR updates the API documentation to include the newly added hackathons list endpoint.

The documented endpoint allows clients to fetch available hackathons using GET /api/hackathons. This docs update reflects the current backend behavior for the public hackathons list API.

Changes Made

  • Documented GET /api/hackathons
  • Added public authentication details
  • Added sample request using curl
  • Added sample JSON response
  • Clarified that the endpoint returns a JSON array
  • Mentioned that pagination, filters, detail, create, update, delete, and registration endpoints are not included in this API yet

Notes

This PR only updates the frontend/docs repository API documentation.
No frontend components, package files, or application logic were modified.

@vercel

vercel Bot commented Jun 1, 2026

Copy link
Copy Markdown

@git-Rag is attempting to deploy a commit to the sandeepvashishtha's projects Team on Vercel.

A member of the Team first needs to authorize it.

Removed references to the Backend Implementation PR from the API documentation.

@Anushreebasics Anushreebasics left a comment

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM!

@Anushreebasics Anushreebasics merged commit 658d2a4 into SandeepVashishtha:master Jun 2, 2026
4 checks passed
@git-Rag

git-Rag commented Jun 2, 2026

Copy link
Copy Markdown
Contributor Author

Hi, this was actually a documentation for the backend implementation fix for PR SandeepVashishtha/Eventra-Backend#53 and were to be labeled as Intermediate/Advanced. I'd appreciate if you could update the labels for the same.

@git-Rag git-Rag deleted the docs/hackathons-list-api branch June 7, 2026 14:12
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants